Class MultiUserManagerImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.system.impl.MultiUserManagerImpl
All Implemented Interfaces:
IPCObject, MultiUserManager

public class MultiUserManagerImpl extends IPCObjectImpl implements MultiUserManager
Information provided by the PKI file:

    \class MultiUserManager
    
    \brief MultiUserManager is the entry point to all Multiuser functionalities.
    
    \example multiUserManager()
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • startServer

      public boolean startServer(int portNumber, String password)
      Information provided by the PKI file:
      
          \brief Starts the Multiuser server with the specified port number and password.
          
          \param portNumber, the port number to listen on.
          \param password, password.
          
          \return bool, true if successful, otherwise false.
          
              
      Specified by:
      startServer in interface MultiUserManager
      Parameters:
      portNumber - Takes in a parameter of portNumber
      password - Takes in a parameter of password
      Returns:
      boolean Returns a boolean
    • stopServer

      public boolean stopServer()
      Information provided by the PKI file:
      
          \brief Stops the Multiuser server.
          
          \return bool, true if successful, otherwise false.
          
              
      Specified by:
      stopServer in interface MultiUserManager
      Returns:
      boolean Returns a boolean
    • isServerStarted

      public boolean isServerStarted()
      Information provided by the PKI file:
      
          \brief Returns true if the Multiuser server is started, otherwise false.
          
          \return bool, true if the Multiuser server is started, otherwise false.
          
              
      Specified by:
      isServerStarted in interface MultiUserManager
      Returns:
      boolean Returns a boolean
    • getPortNumber

      public int getPortNumber()
      Information provided by the PKI file:
      
          \brief Returns the port number the Multiuser server is listening on.
          
          \return int, the port number the Multiuser server is listening on.
          
              
      Specified by:
      getPortNumber in interface MultiUserManager
      Returns:
      int Returns a int
    • setPassword

      public void setPassword(String password)
      Information provided by the PKI file:
      
          \brief Sets the password for the Multiuser server.
          
          \param password, the password for Multiuser server.
          
              
      Specified by:
      setPassword in interface MultiUserManager
      Parameters:
      password - Takes in a parameter of password
    • getPassword

      public String getPassword()
      Information provided by the PKI file:
      
          \brief Returns the password for the Multiuser server.
          
          \return QString, the password for the Multiuser server.
          
              
      Specified by:
      getPassword in interface MultiUserManager
      Returns:
      String Returns a String
    • setAcceptMode

      public void setAcceptMode(AcceptMode acceptMode)
      Information provided by the PKI file:
      
          \brief Sets the existing remote networks accept mode.
          
          \param acceptMode,  the accept mode.
          Modes:      eAlwaysAccept = 0,
          eAlwaysDeny = 1,
          ePrompt = 2
          
              
      Specified by:
      setAcceptMode in interface MultiUserManager
      Parameters:
      acceptMode - Takes in a parameter of acceptMode
    • getAcceptMode

      public AcceptMode getAcceptMode()
      Information provided by the PKI file:
      
          \brief Returns the existing remote networks accept mode.
          
          \return AcceptMode, the accept mode.
          Modes:      eAlwaysAccept = 0,
          eAlwaysDeny = 1,
          ePrompt = 2
          
              
      Specified by:
      getAcceptMode in interface MultiUserManager
      Returns:
      AcceptMode Returns a AcceptMode
    • setNewRNetAcceptMode

      public void setNewRNetAcceptMode(AcceptMode acceptMode)
      Information provided by the PKI file:
      
          \brief Sets the new remote networks accept mode.
          
          \param acceptMode,  the accept mode.
          Modes:      eAlwaysAccept = 0,
          eAlwaysDeny = 1,
          ePrompt = 2
          
              
      Specified by:
      setNewRNetAcceptMode in interface MultiUserManager
      Parameters:
      acceptMode - Takes in a parameter of acceptMode
    • getNewRNetAcceptMode

      public AcceptMode getNewRNetAcceptMode()
      Information provided by the PKI file:
      
          \brief Returns the new remote networks accept mode.
          
          \return AcceptMode, the accept mode.
          Modes:      eAlwaysAccept = 0,
          eAlwaysDeny = 1,
          ePrompt = 2
          
              
      Specified by:
      getNewRNetAcceptMode in interface MultiUserManager
      Returns:
      AcceptMode Returns a AcceptMode
    • getRemoteNetworkCount

      public int getRemoteNetworkCount()
      Information provided by the PKI file:
      
          \brief Returns the number of remote networks on the workspace.
          
          \return int, the number of remote networks on the workspace.
          
              
      Specified by:
      getRemoteNetworkCount in interface MultiUserManager
      Returns:
      int Returns a int
    • getRemoteNetworkAt

      public RemoteNetwork getRemoteNetworkAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the remote network at the specified index.
          
          \param index, the index of the remote network of interest.
          
          \return RemoteNetwork, the RemoteNetwork object at the specified index.
          
              
      Specified by:
      getRemoteNetworkAt in interface MultiUserManager
      Parameters:
      index - Takes in a parameter of index
      Returns:
      RemoteNetwork Returns a RemoteNetwork
    • getRemoteNetworkByName

      public RemoteNetwork getRemoteNetworkByName(String name)
      Information provided by the PKI file:
      
          \brief Returns the remote network with the specified name.
          
          \param name, the name of the remote network of interest.
          
          \return RemoteNetwork, the RemoteNetwork object with the specified name.
          
              
      Specified by:
      getRemoteNetworkByName in interface MultiUserManager
      Parameters:
      name - Takes in a parameter of name
      Returns:
      RemoteNetwork Returns a RemoteNetwork
    • getListeningAddresses

      public String getListeningAddresses()
      Information provided by the PKI file:
      
          \brief Returns the IP addresses the Multiuser server is listening on.
          
          \return QString, the IP addresses the Multiuser server is listening on.
          
              
      Specified by:
      getListeningAddresses in interface MultiUserManager
      Returns:
      String Returns a String
    • writeUdpDatagram

      public void writeUdpDatagram()
      Information provided by the PKI file:
      
          \brief Sends a UDP datagram over the Multiuser connection.
          
              
      Specified by:
      writeUdpDatagram in interface MultiUserManager
    • getMulticastSenderIp

      public String getMulticastSenderIp()
      Information provided by the PKI file:
      
          \brief Returns the source IP address of the multicast datagram.
          
          \return QString, the source IP address of the multicast datagram.
          
              
      Specified by:
      getMulticastSenderIp in interface MultiUserManager
      Returns:
      String Returns a String